/*
 * Copyright (c) 2024 endless-sky
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#ifndef _HAL_OSD_H_
#define _HAL_OSD_H_

#ifdef __cplusplus
extern "C" {
#endif

#include "hal_struct.h"

/**
 * @function:   Hal_Osd_Init
 * @brief:      初始化
 * @param [in]:  HAL_OSD_FONT_S *pFontFile  字库文件路径
 *
 * @return:     DSP_SUCCESS成功，其他值 错误
 */
int32_t Hal_Osd_Init(HAL_OSD_FONT_S *pFontFile);

/**
 * @function:   Hal_Osd_Exit
 * @brief:      反初始化退出
 * @param[in]:  void
 *
 * @return:     DSP_SUCCESS成功，其他值 错误
 */
int32_t Hal_Osd_Exit(void);

/**
 * @function:   Hal_Osd_String
 * @brief:      叠加字符串到编码视频中
 * @param[in]:  HAL_U8 u8SenIdx      视频输入通道号
 * @param[in]:  HAL_OSD_CFG_S *pCfg  叠加参数
 *
 * @return:     DSP_SUCCESS成功，其他值 错误
 */
int32_t Hal_Osd_String(uint8_t u8SenIdx, HAL_OSD_CFG_S *pCfg);

#ifdef __cplusplus
}
#endif

#endif // _HAL_OSD_H_
